hallcurrent25.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef HALLCURRENT25_H
#define HALLCURRENT25_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define HALLCURRENT25_INPUT_CHANNEL_VOUT        0
#define HALLCURRENT25_INPUT_CHANNEL_VOC         1

#define HALLCURRENT25_NUM_CONVERSIONS           200

#define HALLCURRENT25_ADC_RESOLUTION            0x0FFF
#define HALLCURRENT25_VREF_3V3                  3.3
#define HALLCURRENT25_VREF_5V                   5.0
#define HALLCURRENT25_VREF                      HALLCURRENT25_VREF_3V3

#define HALLCURRENT25_TIMEOUT_MS                2000

#define HALLCURRENT25_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define HALLCURRENT25_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 // hallcurrent25_set



#define HALLCURRENT25_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.fault = MIKROBUS( mikrobus, MIKROBUS_INT )
 // hallcurrent25_map // hallcurrent25

typedef struct
{
    // Input pins
    digital_in_t fault;             
 
    // Modules
    spi_master_t spi;               
 
    pin_name_t   chip_select;       
    float        zero_curr_offset;  
    float        data_resolution;   
 
} hallcurrent25_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
 
    // Additional gpio pins
    pin_name_t fault;               
 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
} hallcurrent25_cfg_t;

typedef enum
{
    HALLCURRENT25_OK = 0,
    HALLCURRENT25_ERROR = -1
 
} hallcurrent25_return_value_t;


void hallcurrent25_cfg_setup ( hallcurrent25_cfg_t *cfg );

err_t hallcurrent25_init ( hallcurrent25_t *ctx, hallcurrent25_cfg_t *cfg );

err_t hallcurrent25_read_raw_adc ( hallcurrent25_t *ctx, uint8_t channel, uint16_t *raw_adc );

err_t hallcurrent25_read_voltage ( hallcurrent25_t *ctx, uint8_t channel, float *voltage );

err_t hallcurrent25_read_voltage_avg ( hallcurrent25_t *ctx, uint8_t channel, uint16_t num_conv, float *voltage_avg );

uint8_t hallcurrent25_get_fault_pin ( hallcurrent25_t *ctx );

err_t hallcurrent25_calib_offset ( hallcurrent25_t *ctx );

err_t hallcurrent25_calib_resolution ( hallcurrent25_t *ctx, float calib_current );

err_t hallcurrent25_read_current ( hallcurrent25_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // HALLCURRENT25_H
 // hallcurrent25
 
// ------------------------------------------------------------------------ END